Assets->Import Package->Custom Package…->选中im_unity_xxx.unitypackage。
Import Unity Package对话框中,勾选所有的复选框。Project View中Assets/Plugins/Android/libs目录下选择特定的CPU架构。Inspector View中Select platforms for plugin勾选Android。android-support-v4.jar。File->Build Settings…的Platform列表中选择iOS;Build Settings->Build,选择输出iOS工程的路径,输入工程名字,导出iOS工程;Build Phases->Link Binary With Libraries下拉菜单中添加下面几个库文件:
libc++.1.tbdlibsqlite3.0.tbdlibresolv.9.tbdSystemConfiguration.frameworklibYouMeCommon.alibyim.alibz.tbdCoreTelephony.frameworkAVFoundation.frameworkAudioToolbox.frameworkCoreLocation.frameworkUniSoundSDKDynamic.xcframework//如果是带云知声语音转文字的sdk需要添加,该库是动态库,需要在General -> Frameworks,libraries,and Embedded Content处将其改成Embed & Sign。CFNetwork.framework//如果是带云知声语音转文字的sdk需要。Security.framework//如果是带云知声语音转文字的sdk需要。libicucore.A.tbd//如果是带云知声语音转文字的sdk需要。
为iOS添加录音权限
iOS使用录音权限,需要在info新加Privacy - Microphone Usage Description键,值为字符串,比如“语音聊天需要录音权限”。
首次录音时会向用户申请权限。配置方式如图(选择Private-Microphone Usage Description)。
为iOS添加地理位置权限【可选】
若使用LBS,需要在info新加Privacy - Location Usage Description键,值为字符串,比如“查看附近的玩家需要获取地理位置权限”。首次使用定位时会向用户申请权限,配置方式如上图录音权限。
在 AndroidManifest.xml 添加权限和网络变化监听配置,然后直接打包apk即可:
<!-- 添加到application节点内 -->
<application xxxx>
<receiver android:name="com.youme.im.NetworkStatusReceiver" android:label="NetworkConnection" >
<intent-filter>
<action android:name="android.net.conn.CONNECTIVITY_CHANGE" />
</intent-filter>
</receiver>
</application>
<!-- 添加到跟application平级 -->
<!-- todo 待确认权限 -->
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.CHANGE_WIFI_STATE" />
<uses-permission android:name="android.permission.CHANGE_NETWORK_STATE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<!-- 获取地理位置的权限,可选 -->
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
如果接入的是带云知声语音识别的版本,需要配置依赖项。
buildSystem需要用Gradle,并且导出Android项目.
修改build.gralde文件。
allprojects {
repositories {
//添加云知声语音识别需要的
mavenCentral()
//添加结束
flatDir{
dirs 'libs'
}
}
}
dependencies {
implementation fileTree(include: ['*.jar','*.aar'], dir: 'libs')
//添加云知声语音识别需要的
implementation 'com.android.support:appcompat-v7:24.1.1'
implementation 'com.squareup.okhttp3:okhttp:3.10.0'
implementation 'com.squareup.okhttp3:logging-interceptor:3.10.0'
//添加结束
}

Unity3D版本的 IM SDK提供的API全部为 C# 接口,接口调用都不会阻塞主线程,凡是本身需要较长耗时的接口调用都会采用异步回调,所以全部接口都可以在主线程中直接使用。调用方需要实现监听类并添加到监听队列里,操作结果通过回调的方式通知到调用方。
IMClient:SDK管理器,用来进行初始化、登录、登出等操作IMDefine:SDK声明,SDK的结构体,错误码等声明IMMessage:SDK声明,SDK的结构体IMChannel:登录登出监听器接口,负责处理登录、登出结果IMConnectEvent:登录,登出,掉线等IMUser:用户定义ChannelEvent:频道相关事件ReconnectEvent:重连事件Config:配置,如设置服务器区域,语音缓存目录等Const:错误码,结构体等声明
引入IM SDK命名空间:
using YIMEngine;
using YouMe;
所有API操作接口都在IMClient对象里。这是一个单例类,可以通过Instance获取到它的实例。通过它就可以调用IM SDK的API接口。
示例:
IMClient imClient = IMClient.Instance;
获得IMClient之后,需要调用初始化接口初始化IM SDK。
接口:
public StatusCode Initialize (string appKey, string secretKey, Config config);
参数:
appKey:用户游戏产品区别于其它游戏产品的标识,可以在游密官网获取、查看。
secretKey:用户游戏产品的密钥,可以在游密官网获取、查看。
config:配置,可选择设置服务器区域,语音缓存目录,日志等级。
返回:
StatusCode:错误码,详细描述见错误码定义。
示例:
var errorcode = IMClient.Instance.Initialize ( "YoumeAppkey", " YoumeAppSecurity", new Config(){ServerZone=ServerZone.China, CachePath="path", LogLevel=LogLevel.NONE});
if (errorcode != StatusCode.Success ){
Log.e("init fail, errorcode:" + errorcode.ToString());
}
备注:
Config类有如下属性(均为可选的设置):ServerZone:服务器区域,枚举类型:
public enum ServerZone
{
China = 0, // 中国
Singapore = 1, // 新加坡
America = 2, // 美国
HongKong = 3, // 香港
Korea = 4, // 韩国
Australia = 5, // 澳洲
Deutschland = 6,// 德国
Brazil = 7, // 巴西
India = 8, // 印度
Japan = 9, // 日本
Ireland = 10, // 爱尔兰
ServerZone_Unknow = 9999 //未知
};
LogLevel: 日志等级,枚举类型:
public enum LogLevel
{
NONE = 0,
FATAL = 1,
ERROR = 10,
WARNING = 20,
INFO = 40,
DEBUG = 50,
VERBOSE = 60
};
CachePath:语音缓存目录
需要开发者实现的监听Action有:
ReceiveMessageListener: 接收消息监听,包括文本,语音,文件,礼物等消息DisconnectListener: 断线事件监听,一般发生在网络异常时KickOffListener: 被踢下线事件监听,在同时登录多个相同userID的情况下,先登录的帐号会被后登录的帐号踢下线ReconnectListener: 重连事件监听,网络异常断开,IM SDK会启动自动重连,返回重连结果RecvRecordVolumeListener: 录音音量值监听GetCurrentLocationListener: 获取当前地理位置监听,需由游密开启LBS服务才有此通知RecvNoticeListener: 对管理员发布的公告的监听CancelNoticeListener: 对管理员发起的取消公告的监听RecvNewMessageListener: 手动接收消息的新消息通知的监听GetRecognizeSpeechTextListener: 仅语音识别的文本内容的监听DownloadListener: 下载监听AccusationListener: 举报结果监听OtherUserChannelEventListener: 其它用户进出频道的监听,需游密后台配置才有此通知
如果不设定就收不到相应事件的通知。建议初始化和设置监听在一起完成。
注:所有回调都在主线程调用
<!-- todo 待检查:所有回调都在主线程调用 *** -->
接口原型:
public void SetReceiveMessageListener(Action<IMMessage> listener);
public void SetDisconnectListener(Action<DisconnectEvent> listener);
public void SetKickOffListener(Action<KickOffEvent> listener);
public void SetReconnectListener (Action<IMReconnectEvent> listener);
public void SetRecvRecordVolumeListener (Action<float> listener);
public void SetGetCurrentLocationListener (Action<YouMe.StatusCode, GeographyLocation> listener);
public void SetRecvNoticeListener (Action<YIMEngine.Notice> listener);
public void SetCancelNoticeListener (Action<ulong, string> listener);
public void SetRecvNewMessageListener (Action<ChatType, string> listener);
public void SetGetRecognizeSpeechTextListener (Action<YouMe.StatusCode, ulong, string> listener);
public void SetDownloadListener(Action<YouMe.StatusCode, AudioMessage, string> listener);
public void SetAccusationListener (Action<YouMe.StatusCode, IMAccusationInfo> listener);
public void SetOtherUserChannelEventListener (Action<OtherUserChannelEvent> listener);
示例:
public class Test : MonoBehaviour {
// Use this for initialization
void Start () {
IMClient.Instance.SetReceiveMessageListener(OnReceiveMessage);
IMClient.Instance.SetDisconnectListener((OnDisconnectEvt)=>
{...});
IMClient.Instance.SetKickOffListener((OnKickOffEvt)=>{...});
IMClient.Instance.SetReconnectListener(OnReconnect);
IMClient.Instance.SetRecvRecordVolumeListener(OnRecordVolume);
IMClient.Instance.SetGetCurrentLocationListener(OnGetCurrentLocation);
IMClient.Instance.SetRecvNoticeListener(OnRecvNotice);
IMClient.Instance.SetCancelNoticeListener(OnCancelNotice);
IMClient.Instance.SetRecvNewMessageListener(OnRecvMessage);
IMClient.Instance.SetGetRecognizeSpeechTextListener(OnGetRecognizeSpeechText);
IMClient.Instance.SetDownloadListener(OnDownload);
IMClient.Instance.SetAccusationListener(OnAccusationResult);
IMClient.Instance.SetOtherUserChannelEventListener(OnOtherUserChannelEvt);
IMClient.Instance.Init ("YoumeAppkey", "YoumeAppSecurity",new Config(){...});
}
...
void OnReceiveMessage(IMMessage msg){...}
void OnReconnect(IMReconnectEvent reconEvent){...}
void OnRecordVolume(float volume){...}
void OnGetCurrentLocation(StatusCode code, GeographyLocation location){...}
void OnRecvNotice(YIMEngine.Notice notice){...}
void OnCancelNotice(ulong noticeID, string channelID){...}
void OnRecvMessage(ChatType chatType, string targetID){...}
void OnGetRecognizeSpeechText(StatusCode code, ulong requestID, string text){...}
void OnDownload(StatusCode code, AudioMessage mes, string savePath){...}
void OnAccusationResult(StatusCode code, IMAccusationInfo accusationInfo){...}
void OnOtherUserChannelEvent(OtherUserChannelEvent otherEvent){...}
}
备注:
Action \<IMReconnectEvent> 参数:IMReconnectEvent:evt 重连事件
IMReconnectEvent有如下属性:EventType: 事件类型,枚举类型,
ReconnectEventType.START_RECONNECT=0, //开始重连
ReconnectEventType.END_RECONNECT=1 //重连结束
Result:重连结果,枚举类型,
ReconnectEventResult.RECONNECTRESULT_SUCCESS=0, //重连成功
ReconnectEventResult.RECONNECTRESULT_FAIL_AGAIN=1,//重连失败,再次重连
ReconnectEventResult.RECONNECTRESULT_FAIL=2 //最终重连失败
完成以上的步骤后就可以使用IM功能了,IM用户登录IM后台服务器后即可以正常收发消息。登录为异步过程,通过回调函数返回是否成功,成功后方能进行后续操作。用户首次登录会自动注册。
原型:
public void Login(string userID, string token, Action<LoginEvent> callback)
参数说明:
userID:用户ID或者游戏角色ID,唯一标识一个用户在应用里的身份,由调用者分配,不可为空字符串,只可由字母或数字或下划线组成,长度限制是255字节
token:使用服务器token验证模式时使用该参数,否则使用空字符串""即可,token通过restAPI获取
Action<LoginEvent>:登录结果的回调通知,在此回调里判断登录是否成功
备注:
Action\<LoginEvent> 参数:LoginEvent:evt 登录事件
LoginEvent有如下属性:Code: 错误码,StatusCode类型UserID:用户ID,string类型
<!-- todo 补充一下回调的代码 -->
示例:
IMClient.Instance.Login("12345","",(evt)=>{
if(evt.Code == StatusCode.Success){
Debug.Log("login success.");
...
}else{
Debug.Log("login fail, errorcode: " + evt.Code.ToString());
...
}
});
常见错误码处理:
YIMErrorcode_ParamInvalid:3 参数无效,检查用户名是否拼写正确且符合参数规则,或者用户名、token是否为nullYIMErrorcode_EngineNotInit:1 未初始化,初始化IM SDKYIMErrorcode_AlreadyLogin:7 已登录,无须再次登录YIMErrorcode_StatusError:5 状态错误,检查是否登出操作未完成又调用登录
<!-- Todo 待开发demo,再给正确的文档 -->
<!-- | 错误码 | 含义 | | ------------- | -------------| | YIMErrorcode_ParamInvalid = 3 | 参数无效,检查用户名是否拼写正确且符合参数规则,或者用户名、token是否为null| | StatusCode.EngineNotInit = 1 | IM SDK未初始化| | YIMErrorcode_AlreadyLogin =7 | IM已登录,无须再次登录| | YIMErrorcode_StatusError = 3 | 状态错误,检查是否登出操作未完成又调用登录| -->
如用户主动退出或需要进行用户切换,则需要调用登出操作。
原型:
public void Logout(Action<LogoutEvent> callback)
<!-- Todo : 接口错误码命名有歧义,需要改SDK 代码 和SDK接入文档。 -->
参数说明:
Action<LogoutEvent>:登出结果的回调通知,在此回调里判断登出是否成功
备注:
Action<LogoutEvent> 参数:LogoutEvent:evt 登出事件
LogoutEvent有如下属性:Code: 错误码,StatusCode类型UserID:用户ID,string类型
示例:
IMClient.Instance.Logout((evt)=>{
Debug.Log("Logout, errocode: " + evt.Code.ToString());
});
常见错误码处理:
YIMErrorcode_StatusError:5 状态错误,检查是否未登录或者登出操作未完成又调用登出
设置用户信息后,在游密消息管理后台才能看到消息发送者的详细信息。
原型:
public StatusCode SetUserInfo (IMUserInfo userInfo)
参数:
userInfo:用户扩展信息,请设置IMUserInfo的以下属性:
NickName:用户昵称,string类型ServerArea:游戏服名称,string类型ServerAreaID:游戏服ID,string类型Location:游戏大区,string类型LocationID:游戏大区ID,string类型Platform:平台名称,string类型PlatformID:平台ID,string类型Level:角色等级,int类型VipLevel:vip等级,int类型Extra:其它自定义扩展信息,建议用json字符串,string类型
返回:
StatusCode:错误码,详细描述见错误码定义
原型:
public void GetUserInfo (string userID, Action<YouMe.StatusCode, IMUserInfo> callback)
参数:
userID:用户的ID(登录IM时用的ID)Action<YouMe.StatusCode, IMUserInfo>:获取用户信息的回调通知
备注:
Action<YouMe.StatusCode, IMUserInfo> 参数:StatusCode:code 错误码IMUserInfo:userInfo 用户扩展信息
IMUserInfo有如下属性:NickName:用户昵称,string类型ServerArea:游戏服名称,string类型ServerAreaID:游戏服ID,string类型Location:游戏大区,string类型LocationID:游戏大区ID,string类型Platform:平台名称,string类型PlatformID:平台ID,string类型Level:角色等级,int类型VipLevel:vip等级,int类型Extra:扩展信息,string类型
原型:
public void QueryUserStatus (string userID, Action<YouMe.StatusCode, IMUserStatus> callback)
参数:
userID:用户的ID(登录IM时用的ID)Action<YouMe.StatusCode, IMUserStatus>:查询用户状态的回调通知
备注:
Action<YouMe.StatusCode, IMUserStatus> 参数:StatusCode:code 错误码IMUserStatus:userStatus 用户状态,枚举类型,
IMUserStatus.ONLINE=0, //在线
IMUserStatus.OFFLINE=1, //离线
IMUserStatus.UNKNOWN=2 //未知
通过IMClient的JoinChannel接口加入聊天频道,如果频道不存在则后台自动创建。有了这个ID就可以收发频道消息。开发者要保证频道号全局唯一,以避免用户进入错误频道。
原型:
public void JoinChannel(IMChannel channel,Action<ChannelEvent> callback)
参数:
channel:请求加入的频道,频道ID仅支持数字、字母、下划线组成的字符串,区分大小写,长度限制为255字节Action<ChannelEvent>:加入频道结果的回调通知
备注:
Action<ChannelEvent> 参数:ChannelEvent:evt 频道事件
ChannelEvent有如下属性:Code:错误码,StatusCode类型ChannelID:频道ID,string类型EventType:枚举类型,
ChannelEventType.JOIN_SUCCESS=0, //加入频道成功
ChannelEventType.LEAVE_SUCCESS=1, //离开频道成功
ChannelEventType.JOIN_FAIL=2, //加入频道失败
ChannelEventType.LEAVE_FAIL=3, //离开频道失败
ChannelEventType.LEAVE_ALL_SUCCESS=4, //离开所有频道成功
ChannelEventType.LEAVE_ALL_FAIL=5 //离开所有频道失败
示例:
IMClient.Instance.JoinChannel(new IMChannel("12345"),(channelEvt)=>{
if (channelEvt.EventType == ChannelEventType.JOIN_SUCCESS){
Debug.Log("JoinChannel success.");
}else{
Debug.Log("JoinChannel fail, errorcode: " + channelEvt.code.ToString());
}
});
常见错误码处理:
YIMErrorcode_ParamInvalid:3 参数无效,检查频道ID是否为null或者“”,拼写是否正确且符合参数规则YIMErrorcode_NotLogin:2 未登录,检查是否未登录或者因为网络原因已经登出
通过IMClient的JoinMultiChannel接口加入多个聊天频道。
原型:
public void JoinMultiChannel(IMChannel[] channels,Action<ChannelEvent> callback)
参数:
channels:频道组Action<ChannelEvent>:加入频道结果的回调通知
备注:
Action<ChannelEvent> 参数:ChannelEvent:evt 频道事件
ChannelEvent有如下属性:Code:错误码,StatusCode类型ChannelID:频道ID,string类型EventType:枚举类型,
ChannelEventType.JOIN_SUCCESS=0, //加入频道成功
ChannelEventType.LEAVE_SUCCESS=1, //离开频道成功
ChannelEventType.JOIN_FAIL=2, //加入频道失败
ChannelEventType.LEAVE_FAIL=3, //离开频道失败
ChannelEventType.LEAVE_ALL_SUCCESS=4, //离开所有频道成功
ChannelEventType.LEAVE_ALL_FAIL=5 //离开所有频道失败
示例:
IMClient.Instance.JoinMultiChannel(channels,(channelEvt)=>{
if (channelEvt.EventType == ChannelEventType.JOIN_SUCCESS){
Debug.Log("JoinChannel success.");
}else{
Debug.Log("JoinChannel fail, errorcode: " + channelEvt.code.ToString());
}
});
通过IMClient的LeaveChannel接口离开频道。
原型:
public void LeaveChannel(IMChannel channel,Action<ChannelEvent> callback)
参数:
channel:请求离开的频道Action<ChannelEvent>:离开频道结果的回调通知
备注:
Action<ChannelEvent> 参数:ChannelEvent:evt 频道事件
ChannelEvent有如下属性:Code:错误码,StatusCode类型ChannelID:频道ID,string类型EventType:枚举类型,
ChannelEventType.JOIN_SUCCESS=0, //加入频道成功
ChannelEventType.LEAVE_SUCCESS=1, //离开频道成功
ChannelEventType.JOIN_FAIL=2, //加入频道失败
ChannelEventType.LEAVE_FAIL=3, //离开频道失败
ChannelEventType.LEAVE_ALL_SUCCESS=4, //离开所有频道成功
ChannelEventType.LEAVE_ALL_FAIL=5 //离开所有频道失败
示例:
IMClient.Instance.LeaveChannel(new IMChannel("12345"),(channelEvt)=>{
if (channelEvt.EventType == ChannelEventType.LEAVE_SUCCESS){
Debug.Log("LeaveChannel success.");
}else{
Debug.Log("LeaveChannel fail, errorcode: " + channelEvt.code.ToString());
}
});
常见错误码处理:
YIMErrorcode_ParamInvalid:3 参数无效,检查频道ID是否为null或者“”YIMErrorcode_NotLogin:2 未登录,检查是否未登录或者因为网络原因已经登出YIMErrorcode_NotJoinRoom:47 未加入频道,检查是否频道ID有误
通过IMClient的LeaveAllChannels接口离开所有频道。
原型:
public void LeaveAllChannels (Action<ChannelEvent> callback)
参数:
Action<ChannelEvent>:离开所有频道结果的回调通知
备注:
Action<ChannelEvent> 参数:ChannelEvent:evt 频道事件
ChannelEvent有如下属性:Code:错误码,StatusCode类型ChannelID:频道ID,string类型EventType:枚举类型,
ChannelEventType.JOIN_SUCCESS=0, //加入频道成功
ChannelEventType.LEAVE_SUCCESS=1, //离开频道成功
ChannelEventType.JOIN_FAIL=2, //加入频道失败
ChannelEventType.LEAVE_FAIL=3, //离开频道失败
ChannelEventType.LEAVE_ALL_SUCCESS=4, //离开所有频道成功
ChannelEventType.LEAVE_ALL_FAIL=5 //离开所有频道失败
示例:
IMClient.Instance.LeaveAllChannels((channelEvt)=>{
if (channelEvt.EventType == ChannelEventType.LEAVE_ALL_SUCCESS){
Debug.Log("LeaveAllChannels success.");
}else{
Debug.Log("LeaveAllChannels fail, errorcode: " + channelEvt.code.ToString());
}
});
通过IMClient的SwitchToChannels接口离开所有频道再重新进入频道。
原型:
public void SwitchToChannels(IMChannel[] channel,Action<ChannelEvent> leaveCallback,Action<ChannelEvent> joinCallback)
参数:
channel:待进入频道组Action<ChannelEvent> leaveCallback:离开所有频道结果的回调通知Action<ChannelEvent> joinCallback:进入频道结果的回调通知
备注:
Action<ChannelEvent> 参数:ChannelEvent:evt 频道事件
ChannelEvent有如下属性:Code:错误码,StatusCode类型ChannelID:频道ID,string类型EventType:枚举类型,
ChannelEventType.JOIN_SUCCESS=0, //加入频道成功
ChannelEventType.LEAVE_SUCCESS=1, //离开频道成功
ChannelEventType.JOIN_FAIL=2, //加入频道失败
ChannelEventType.LEAVE_FAIL=3, //离开频道失败
ChannelEventType.LEAVE_ALL_SUCCESS=4, //离开所有频道成功
ChannelEventType.LEAVE_ALL_FAIL=5 //离开所有频道失败
示例:
IMClient.Instance.SwitchToChannels(channels, (leaveChannelEvt)=>{
if (leaveChannelEvt.EventType == ChannelEventType.LEAVE_ALL_SUCCESS){
Debug.Log("LeaveAllChannels success.");
}else{
Debug.Log("LeaveAllChannels fail, errorcode: " + leaveChannelEvt.code.ToString());
}
},
(joinChannelEvt)=>{
if (joinChannelEvt.EventType == ChannelEventType.JOIN_SUCCESS){
Debug.Log("JoinChannel success.");
}else{
Debug.Log("JoinChannel fail, errorcode: " + joinChannelEvt.code.ToString());
}
});
此功能默认不开启,需要的请联系我们开启此服务。联系我们,可以通过专属游密支持群或者技术支持的大群。
小频道(小于100人)内,当其他用户进入或退出频道,设置其它用户进出频道的监听后会收到其他用户进出通知
注意:SetOtherUserChannelEventListener宜在初始化前调用。
示例:
IMClient.Instance.SetOtherUserChannelEventListener(OnOtherUserChannelEvent);
...
void OnOtherUserChannelEvent(OtherUserChannelEvent otherEvent){
if (otherEvent.EventType == OtherUserChannelEventType.JOIN_CHANNEL){
Debug.Log("userID=" + otherEvent.UserID + " 进入频道:" + otherEvent.ChannelID);
}else{
Debug.Log("userID=" + otherEvent.UserID + " 离开频道:" + otherEvent.ChannelID);
}
}
备注:
Action<OtherUserChannelEvent> 参数:OtherUserChannelEvent:evt 其它用户进出频道事件
OtherUserChannelEvent有如下属性:UserID:用户ID,string类型ChannelID:频道ID,string类型EventType:枚举类型,
OtherUserChannelEventType.JOIN_CHANNEL=0, //其它用户进入频道
OtherUserChannelEventType.LEAVE_CHANNEL=1 //其它用户离开频道
获取进入频道的用户数量。
原型:
public void GetRoomMemberCount (IMChannel channel, Action<YouMe.StatusCode, string, uint> callback)
参数:
channel:频道(已成功加入此频道才能获取该频道的人数)Action<YouMe.StatusCode, string, uint>:获取频道成员数量结果的回调通知
备注:
Action<YouMe.StatusCode, string, uint> 参数:YouMe.StatusCode:code 错误码string:channelID 频道IDuint:count 人数
示例:
IMClient.Instance.GetRoomMemberCount(new IMChannel("12345"),(code, channelID, count)=>{
Log.e("获取成员数量回调,code:"+code.ToString()+",channelID:"+channelID+", count:"+count.ToString());
});
设置接收消息的监听SetReceiveMessageListener(Action<IMMessage> listener),可以接收消息。
备注:
Action<IMMessage> ,IMMessage有如下继承类:AudioMessage:语音消息TextMessage:文本消息GiftMessage:礼物消息CustomMessage:自定义消息FileMessage:文件消息
IMMessage有如下属性:MessageType:消息类型,MessageBodyType类型SenderID:私聊时为发送者ID,频道聊天时为频道ID,string类型ReciverID:接收者ID,string类型ChatType:聊天类型,枚举类型,
ChatType.Unknow=0,
ChatType.PrivateChat=1,
ChatType.RoomChat=2
IsReceiveFromServer:是否从服务器接收,bool类型SendStatus:发送状态,枚举类型,
SendStatus.NotStartSend=0, //未发送
SendStatus.Sending=1, //发送中
SendStatus.Sended=2, //已发送
SendStatus.Fail=3 //发送失败
SendTime:发送时间,uint类型RequestID:消息ID,ulong类型
示例:
public void OnReceiveMessage (IMMessage msg)
{
if (msg.MessageType == MessageBodyType.Voice){
var audioMsg = (AudioMessage)msg;
Debug.Log (
"OnRecvMessage voice 文字识别结果:" + audioMsg.RecongnizeText
+ " send:" + audioMsg.SenderID
+ "recv:" + audioMsg.ReciverID
+ " 语音时长:" + audioMsg.AudioDuration +"秒"
+ " 自定义参数:" + audioMsg.ExtraParam
);
// 下载语音消息,使用默认的下载路径时,路径参数可不填
StatusCode code = audioMsg.Download ((code, audioMes)=>{
Log.e ("下载语音文件回调,code:" + code.ToString () + ", savepath:" + audioMes.AudioFilePath);
});
}else if (msg.MessageType == MessageBodyType.TXT){
var textMsg = (TextMessage)msg;
Debug.Log ("OnRecvMessage txt:" +
textMsg.Content + " send:" + textMsg.SenderID + "recv:" + textMsg.ReciverID);
}else if (msg.MessageType == MessageBodyType.File) {
var fileMsg = (FileMessage)msg;
Debug.Log (
"OnRecvMessage file fileName:" + fileMsg.FileName
+ " send:" + fileMsg.SenderID
+ "recv:" + fileMsg.ReciverID
+ " fileType:" + fileMsg.FileType
+ " fileSize:" + fileMsg.FileSize
);
//下载文件
IMClient.Instance.DownloadFile (fileMsg.RequestID, savepath, (down_code, path) => {
Log.e ("下载文件回调,code:" + down_code.ToString () + ", savepath:" + path);
});
}else if (msg.MessageType == MessageBodyType.Gift) {
var giftMsg = (GiftMessage)msg;
Debug.Log (
"OnRecvMessage gift AnchorID:" + giftMsg.AnchorID
+ " count:" + giftMsg.GiftCount
+ " giftID:" + giftMsg.GiftID
);
}else if (msg.MessageType == MessageBodyType.CustomMesssage) {
var customMsg = (CustomMessage)message;
Debug.Log ("OnRecvMessage customMessage:" +
System.Convert.ToBase64String(customMsg.Content) + " send:" + customMsg.SenderID + "recv:" + customMsg.ReciverID);
}
}
可通过IMClient的SendTextMessage接口发送文本消息。
原型:
public void SendTextMessage (string reciverID, ChatType chatType, string msgContent, Action<YouMe.StatusCode,TextMessage> OnSendCallBack)
参数:
reciverID:接收者ID,私聊传入用户ID,频道聊天传入频道IDchatType:聊天类型,私聊/频道聊天msgContent:文本消息内容Action<YouMe.StatusCode,TextMessage>:消息发送结果的回调通知
备注:
Action<YouMe.StatusCode,TextMessage> 参数:YouMe.StatusCode:code 错误码TextMessage:textMsgObj 文本消息
TextMessage有如下属性:Content:文本内容,string类型
示例:
IMClient.Instance.SendTextMessage("123456",ChatType.PrivateChat,"文本消息",(code,textMsgObj)=>{
if (code == StatusCode.Success)
{
Debug.Log("发送:" + textMsgObj.Content + " 成功");
}else{
Debug.Log("发送:" + textMsgObj.Content + " 失败");
}
});
用于群发文本消息的接口,每次不要超过200个用户。
原型:
public StatusCode MultiSendTextMessage(List<string> recvLists,string strText)
参数:
recvLists:接受消息的用户id列表strText:文本消息内容
返回:
StatusCode:错误码,详细描述见错误码定义
给主播发送礼物消息的接口,支持在游密主播后台查看礼物消息信息和统计信息。客户端还是通过接收消息的监听收消息。
原型:
public void SendGift (string anchorID, IMChannel channel, int giftID, int giftCount, ExtraGifParam extParam, Action<YouMe.StatusCode,GiftMessage> OnSendCallBack)
参数:
anchorID:主播idchannel:主播频道id,通过JoinChannel进入频道的用户可以接收到消息。giftID:礼物物品id,特别的是0表示只是留言giftCount:礼物物品数量extParam:扩展内容,参考ExtraGifParam类熟悉说明Action<YouMe.StatusCode,GiftMessage>:礼物消息发送结果的回调通知
备注:
Action<YouMe.StatusCode,GiftMessage> 参数:YouMe.StatusCode:code 错误码GiftMessage:giftMsgObj 礼物消息
GiftMessage有如下属性:AnchorID:主播ID即礼物接收者ID,string类型GiftID:礼物ID,int类型GiftCount:礼物数量,int类型ExtraParam:额外参数,ExtraGifParam类型
ExtraGifParam有如下属性:NickName:昵称,string类型ServerArea:游戏服,string类型Location:大区,string类型Score:积分,long类型Level:角色等级,int类型VipLevel:vip等级,int类型Extra:扩展信息,string类型
示例:
IMClient.Instance.SendGift("56789",new IMChannel("5678"),2,2, null, (code,giftMsgObj)=>{
Debug.Log("发送礼物回调,code:" + code.ToString() + ", AnchorID:" + giftMsgObj.AnchorID + ",giftID:" + giftMsgObj.GiftID + ",giftCount:" + giftMsgObj.GiftCount);
});
可通过IMClient的SendCustomMessage接口发送用户自定义消息,自定义数据是二进制数据。
原型:
public void SendCustomMessage (string reciverID, ChatType chatType, byte[] customMsg, Action<YouMe.StatusCode,CustomMessage> OnSendCallBack)
参数:
reciverID:接收者ID(用户ID或者频道ID)chatType:聊天类型,私聊/频道聊天customMsg:自定义消息内容Action<YouMe.StatusCode,CustomMessage>:消息发送结果的回调通知
备注:
Action<YouMe.StatusCode,CustomMessage> 参数:YouMe.StatusCode:code 错误码CustomMessage:cusMsgObj 自定义消息
CustomMessage有如下属性:Content:自定义消息内容,byte[]类型
示例:
IMClient.Instance.SendCustomMessage("12345",ChatType.PrivateChat,bytemsg,(code, cusMsgObj)=>{
Debug.Log("发送自定义消息回调,code:" + code.ToString()+ ",reciverID:" + cusMsgObj.ReciverID + ",sendStatus:" + cusMsgObj.SendStatus);
});
可通过IMClient的SendFile接口发送文件消息。
原型:
public void SendFile (string reciverID, ChatType chatType, string filePath, string extParam, FileType fileType, Action<YouMe.StatusCode,FileMessage> OnSendCallBack)
参数:
reciverID:接收者ID(用户ID或者频道ID)chatType:聊天类型,私聊/频道聊天filePath:要发送的文件绝对路径,包括文件名extParam:附加参数,格式自己定义,自己解析fileType:文件类型,枚举类型,
FileType.FileType_Other=0 //其它
FileType.FileType_Audio=1 //音频
FileType.FileType_Image=2 //图片
FileType.FileType_Video=3 //视频
Action<YouMe.StatusCode,FileMessage>:消息发送结果的回调通知
备注:
Action<YouMe.StatusCode,FileMessage> 参数:YouMe.StatusCode:code 错误码FileMessage:fileMsgObj 文件消息
FileMessage有如下属性:FileType:文件类型,枚举类型,
FileType.FileType_Other=0, //其它
FileType.FileType_Audio=1, //音频
FileType.FileType_Imag=2, //图片
FileType.FileType_Video=3 //视频
FileName:文件名字,string类型FileSize:文件大小,int类型ExtraParam:额外参数,string类型Extension:文件扩展名,string类型
示例:
IMClient.Instance.SendFile("12345", ChatType.PrivateChat, "", "", FileType.FileType_Other, (code,fileMsgObj)=>{
Debug.Log("发送文件回调, code:" + code.ToString()+ ",fileName:" + fileMsgObj.FileName + ",fileSize:" + fileMsgObj.FileSize);
});
接收消息接口参考收消息通过MessageType属性分拣出文件消息File,然后调用函数DownloadFile下载文件。
windows下,会对下载接口的保存路径参数的'/'转换为'\';如果传入的保存路径参数不符合windows下的路径格式,下载回调中的保存路径可能和传入的保存路径不同
原型:
public void DownloadFile (ulong requestID, string targetFilePath, Action<YouMe.StatusCode,IMMessage,string> downloadCallback)
参数:
requestID:消息IDtargetFilePath:文件保存路径(带文件名的全路径),如果目录不存在,SDK会自动创建,必须保证该路径有可写权限downloadCallback:文件下载回调
备注:
Action<YouMe.StatusCode,IMMessage,string> 参数:YouMe.StatusCode:code 错误码IMMessage:messageObj 消息体,详见收消息string:savePath 文件保存路径
语音消息聊天简要流程:
接收方接收语音消息通知后,调用方控制是否下载,调用下载接口就可以获取录音内容。然后开发者调用游戏引擎的播放接口播放wav音频文件。
StartRecordAudio提供语音识别功能,将语音识别为文字,默认输入语音为普通话,识别文字为简体中文,可通过SetSpeechRecognizeLanguage函数设置语言。此服务需要联系我们进行配置。
原型:
public StatusCode SetSpeechRecognizeLanguage (SpeechLanguage language)
参数:
language:语言,枚举类型,
SpeechLanguage.SPEECHLANG_MANDARIN=0, //普通话(Android IOS Windows)
SpeechLanguage.SPEECHLANG_YUEYU=1, //粤语(Android IOS Windows)
SpeechLanguage.SPEECHLANG_SICHUAN=2, //四川话(Android IOS)
SpeechLanguage.SPEECHLANG_HENAN=3, //河南话(IOS)
SpeechLanguage.SPEECHLANG_ENGLISH=4 //英语(Android IOS Windows)
SpeechLanguage.SPEECHLANG_TRADITIONAL=5 //繁体中文
返回:
StatusCode:错误码,详细描述见错误码定义
StartRecordAudio提供语音识别功能,将语音识别为文字,默认输入语音为普通话,识别文字为简体中文。
可通过SetSpeechRecognizeLanguageByCode函数设置语言。此服务需要联系我们进行配置。(目前此接口只支持google语音识别)
原型:
public StatusCode SetSpeechRecognizeLanguageByCode(string languageCode)
参数:
languageCode:语言代码,BCP-47格式(如zh-CN, en-US )。
[支持的语言列表](https://cloud.google.com/speech/docs/languages)
返回:
StatusCode:错误码,详细描述见错误码定义
SetDownloadAudioMessageSwitch()在初始化之后,启动语音之前调用;若设置了自动下载语音消息,不需再调用AudioMessage.Download()或者DownloadFile()接口,收到语音消息时会自动下载,若调用SetDownloadListener(Action<YouMe.StatusCode, AudioMessage, string> listener)接口设置过下载的监听,下载完成会收到下载完成的通知。
原型:
public StatusCode SetAutoDownloadAudioMessage (bool download)
参数:
download:true-自动下载语音消息,false-不自动下载语音消息(默认)
返回:
StatusCode:错误码,详细描述见错误码定义
备注:
Action<YouMe.StatusCode,AudioMessage> 参数:YouMe.StatusCode:code 错误码AudioMessage:audioMsgObj 语音消息
AudioMessage有如下属性:RecongnizeText:语音识别的文本,string类型AudioFilePath:语音文件路径,string类型IsRecognizeText:是否开启了语音文字识别,bool类型MessageDownloadStatus:语音消息下载状态,枚举类型,
MessageDownloadStatus.NOTDOWNLOAD=0, //未下载
MessageDownloadStatus.DOWNLOADING=1, //下载中
MessageDownloadStatus.DOWNLOADED=2, //已下载
MessageDownloadStatus.DOWNLOAD_FAIL=3 //下载失败
AudioDuration:语音时长,int类型ExtraParam:附加信息,string类型
调用IMClient的StartRecordAudio语音发送接口,调用StopRecordAndSendAudio接口后自动停止录音并发送,或者调用CancleRecordAudio取消本次消息发送。注意:语音消息最大的时长是1分钟(超过1分钟就自动发出去)。
原型:
public StatusCode StartRecordAudio (string reciverID, ChatType chatType, string extraMsg, bool recognizeText, bool IsOpenOnlyRecognizeText = false)
参数:
reciverID:接收者ID,私聊传用户id,频道聊天传频道idchatType:聊天类型,私聊/频道聊天extraMsg:附带自定义文本消息内容,可为空recognizeText:是否开启语音转文字识别功能IsOpenOnlyRecognizeText:可选参数,仅需要语音识别的文本内容,不发送语音;默认不开启,未开启语音转文字功能忽略此参数, 若此值为真,调用StopAudioMessage成功后会收到OnGetRecognizeSpeechText回调 注意:需设置获取语音识别文本监听才能收到语音识别后的文本内容
返回:
StatusCode:错误码,详细描述见错误码定义
原型:
public void StopRecordAndSendAudio (Action<YouMe.StatusCode,AudioMessage> callback)
参数:
Action<YouMe.StatusCode,AudioMessage>:语音消息发送回调通知,会通知多次,通过AudioMessage的SendStatus属性可以判断是哪个状态的回调
备注:
Action<YouMe.StatusCode,AudioMessage> 参数:YouMe.StatusCode:code 错误码AudioMessage:audioMsgObj 语音消息
AudioMessage有如下属性:RecongnizeText:语音识别的文本,string类型AudioFilePath:语音文件路径,string类型IsRecognizeText:是否开启了语音文字识别,bool类型MessageDownloadStatus:语音消息下载状态,枚举类型,
MessageDownloadStatus.NOTDOWNLOAD=0, //未下载
MessageDownloadStatus.DOWNLOADING=1, //下载中
MessageDownloadStatus.DOWNLOADED=2, //已下载
MessageDownloadStatus.DOWNLOAD_FAIL=3 //下载失败
AudioDuration:语音时长,int类型ExtraParam:附加信息,string类型
原型:
public StatusCode CancleRecordAudio()
返回:
StatusCode:错误码,详细描述见错误码定义
可以使用AudioMessage.Download()下载接口下载语音消息,用法参考消息收发。
windows下,会对下载接口的保存路径参数的'/'转换为'\';如果传入的保存路径参数不符合windows下的路径格式,下载回调中的保存路径可能和传入的保存路径不同
原型:
public void Download (Action<StatusCode,AudioMessage> downloadCallback, string targetPath = "")
参数:
downloadCallback:语音消息下载回调targetPath:可选参数,语音消息下载的存放路径,默认值为“”;若未设置下载目录且参数使用默认值,下载路径就是默认的下载路径;若设置了下载目录且参数使用默认值,下载路径为设置的下载目录;若参数不是默认值,下载路径就是参数指定的路径
备注:
Action<YouMe.StatusCode,AudioMessage> 参数:YouMe.StatusCode:code 错误码AudioMessage:audioMes 语音消息
可以使用AudioMessage.PlayAudio()播放接口进行播放,目前只支持WAV格式,用法参考消息收发。
原型:
public void PlayAudio(Action<StatusCode, string> playCallback, float volume = 1.0f)
参数:
Action<StatusCode, string> playCallback:语音播放回调volume:可选参数,语音播放的音量值,范围:0.0-1.0 默认是1.0f
备注:
Action<YouMe.StatusCode,string> 参数:YouMe.StatusCode:code 错误码,StatusCode.Success或者StatusCode.PTT_IsPlaying,都是操作成功,StatusCode.PTT_IsPlaying 表示覆盖了当前正在播放的音频文件。string:filePath 播放的音频文件路径
可以使用AudioMessage.StopPlay()停止播放当前语音,用法参考消息收发。
原型:
public StatusCode StopPlay ()
返回:
StatusCode:错误码,详细描述见错误码定义
获取录音缓存目录。
原型:
public string GetAudioCachePath ()
返回:
返回初始化时设置的录音缓存目录的完整路径。
清空当前设置的录音缓存目录(注意清空语音缓存目录后历史记录中会无法读取到音频文件,调用清理历史记录接口也会自动删除对应的音频缓存文件)。
原型:
public bool ClearAudioCachePath ()
返回:
true:表示清理成功,false:表示清理操作失败。
下载保存目录是的默认下载目录,对下载语音消息和文件均适用;设置下载保存目录在初始化之后,启动语音之前调用,若设置了下载保存目录,调用DownloadFile()时其中的savePath参数可以为空字符串(若savePath参数为空字符串时,下载语音消息和文件会生成以时间戳为前缀的文件)。
原型:
public StatusCode SetDownloadDir (string path)
参数:
path:下载目录路径。
返回:
StatusCode:错误码,详细描述见错误码定义
原型:
public void GetMicrophoneStatus (Action<YouMe.StatusCode,IMAudioDeviceStatus> callback)
参数:
Action<YouMe.StatusCode,IMAudioDeviceStatus>:获取麦克风状态的回调通知
备注:
Action<YouMe.StatusCode,IMAudioDeviceStatus> 参数:YouMe.StatusCode:code 错误码IMAudioDeviceStatus:status 麦克风设备状态,枚举类型,
IMAudioDeviceStatus.AVAILABLE=0, //可用
IMAudioDeviceStatus.NO_AUTHORITY=1, //无权限
IMAudioDeviceStatus.MUTE=2, //静音
IMAudioDeviceStatus.UNAVAILABLE=3, //不可用
IMAudioDeviceStatus.UNKNOWN=4 //未知,一般是获取麦克风状态失败
原型:
public bool StartAudioSpeech (bool translate)
参数:
translate:是否进行语音转文字识别
返回:
true:表示启动录音成功,false:表示启动录音失败。
该接口自动上传并只返回音频文件的下载链接,不会自动发送。
原型:
public void StopAudioSpeech (Action<YouMe.StatusCode, SpeechInfo> callback)
参数:
Action<YouMe.StatusCode, SpeechInfo>:语音上传回调
相关接口:
//取消本次录音
public StatusCode CancleRecordAudio()
备注:
Action<YouMe.StatusCode, SpeechInfo> 参数:YouMe.StatusCode:code 错误码SpeechInfo:speechInfo 录音信息
SpeechInfo有如下属性:RequestID:消息ID,ulong类型DownloadURL:下载链接Url,string类型Duration:录音时长,int类型FileSize:文件大小,int类型LocalPath:录音文件的本地路径,string类型Text:录音识别的文本,可能为空null 或者 “”,string类型HasUpload:是否已上传,bool类型
原型:
public void DownloadFileByUrl (string downloadUrl, string savePath, Action<YouMe.StatusCode, string> downloadCallback)
参数:
downloadUrl:语音文件的url下载地址savePath:语音文件的本地存放地址,带文件名的全路径Action<YouMe.StatusCode, string>:文件下载回调
备注:
Action<YouMe.StatusCode, string> 参数:YouMe.StatusCode:code 错误码string:savePath 本地保存路径
若屏蔽用户的消息,此屏蔽用户发送的私聊/频道消息都接收不到。
原型:
public void BlockUser (string userID, bool block, Action<YouMe.StatusCode, bool> callback)
参数:
userID:用户IDblock:true-屏蔽 false-解除屏蔽Action<YouMe.StatusCode, bool>:屏蔽用户的回调通知
备注:
Action<YouMe.StatusCode, bool> 参数:YouMe.StatusCode:code 错误码bool:block 是否被屏蔽
原型:
public void UnBlockAllUser (Action<YouMe.StatusCode> callback)
参数:
Action<YouMe.StatusCode>:解除所有屏蔽用户的回调通知
备注:
Action<YouMe.StatusCode> 参数:YouMe.StatusCode:code 错误码
获取被自己屏蔽接收消息的所有用户。
原型:
public void GetBlockUsers (Action<YouMe.StatusCode, List<string> > callback)
参数:
Action<YouMe.StatusCode, List<string>>:获取屏蔽用户的回调通知
备注:
Action<YouMe.StatusCode, List<string>> 参数:YouMe.StatusCode:code 错误码List<string>:userList 屏蔽的用户ID列表
在自动接收消息和手动接收消息间切换,默认是自动接收消息。
原型:
public StatusCode SetAutoRecvMsg (List<string> targets, bool bAutoRecv)
参数:
targets:频道ID,可以指定多个bAutoRecv:true为自动接收消息,false为手动接收消息,默认为true。
返回:
StatusCode:错误码,详细描述见错误码定义
在手动接收消息模式,调用SetReciveMessageListener(Action<IMMessage> listener)接口设置监听才能监听到接收消息的通知。
原型:
public StatusCode GetNewMessage (List<string> targets)
参数:
targets:频道ID,可以指定多个
返回:
StatusCode:错误码,详细描述见错误码定义
在手动接收消息模式,会通知新消息大概数量,调用SetRecvNewMessageListener (Action<ChatType, string> listener)接口设置监听才能收到新消息的通知。
示例:
...
IMClient.Instance.SetRecvNewMessageListener
(OnRecvNewMessage);
...
OnRecvNewMessage(YIMEngine.ChatType chatType, string targetID){...}
备注:
Action<ChatType, string> 参数:ChatType:chatType 聊天类型,私聊/频道聊天string:targetID 如果是频道聊天,该值为频道ID;私聊该值为空
设置是否在本地保存频道聊天记录,默认不保存。私聊历史记录默认保存。
原型:
public void SetRoomHistoryMessageSwitch (List<string> channelIDs, bool save)
参数:
channelIDs:频道id,指定要保存本地历史记录的频道ID,可以一次设置多个,对应 JoinChannel 指定的ID。save:true表示保存聊天记录,false表示不保存聊天记录,默认为false。
从服务器拉取频道最近的聊天历史记录。
这个功能默认不开启,需要的请联系我们修改服务器配置。联系我们,可以通过专属游密支持群或者技术支持的大群。
原型:
public void QueryRoomHistoryMessageFromServer (string channelID, int count, int direction,Action<YouMe.StatusCode, string, uint, List<IMMessage>> callback)
参数:
channelID:频道idcount:消息数量(最多200条)direction:历史消息排序方向 0:按时间戳升序 1:按时间戳逆序Action<YouMe.StatusCode, string, uint, List<IMMessage>>:查询频道历史消息的回调通知
备注:
Action<YouMe.StatusCode, string, uint, List<IMMessage>>参数:StatusCode:错误码,详细描述见错误码定义string:channelID 频道IDuint:remain 剩余数量List<IMMessage>:imMsgList 消息列表
原型:
public void QueryHistoryMessage (string targetID, ChatType chatType, ulong startMessageID, int count, int direction, Action<YouMe.StatusCode,IMHistoryMessageInfo> callback)
参数:
targetID:用户ID或者频道IDchatType:表示查询私聊或者频道聊天的历史记录startMessageID:起始历史记录消息id(与requestid不同),为0表示首次查询,将倒序获取count条记录count:最多获取多少条direction:历史记录查询方向,startMessageID=0时,direction使用默认值0; startMessageID>0时,0表示查询比startMessageID小的消息,1表示查询比startMessageID大的消息Action<YouMe.StatusCode,IMHistoryMessageInfo>: 查询历史消息的回调通知
相关函数:
对于频道本地记录,需要先设置自动保存频道消息。SetRoomHistoryMessageSwitch
备注:
Action<YouMe.StatusCode,IMHistoryMessageInfo> 参数:StatusCode:code 错误码IMHistoryMessageInfo:historyInfo 历史消息
IMHistoryMessageInfo有如下属性:TargetID:用户ID,string类型Remain:剩余历史消息条数,int类型HistoryMesList:消息列表,List<HistoryMsg>类型
HistoryMsg有如下属性:MessageType:消息内容类型,枚举类型
MessageBodyType.Unknow=0, //未知
MessageBodyType.TXT=1, //文本
MessageBodyType.CustomMesssage=2,//自定义
MessageBodyType.Emoji=3, //表情
MessageBodyType.Image=4, //图片
MessageBodyType.Voice=5, //语音
MessageBodyType.Video=6, //视频
MessageBodyType.File=7, //文件
MessageBodyType.Gift=8 //礼物
ChatType:聊天类型,私聊/频道聊天,目前历史记录都是私聊,枚举类型
ChatType.Unknow=0, //未知
ChatType.PrivateChat=1, //私聊
ChatType.RoomChat=3 //频道聊天
CreateTime:消息收发时间,int类型LocalPath:语音消息的wav文件本地路径,string类型Text:文本消息内容 或者 语音消息的文本识别内容,string类型MessageID:历史记录消息ID,ulong类型SenderID:消息发送者ID,string类型ReceiveID:消息接收者ID,string类型Param:如果是语音消息,该值表示语音消息的自定义附加参数,string类型Duration:如果是语音消息,该值表示语音消息时长,int类型IsRead:是否已读,bool类型CustomMsg:如果是自定义消息,该值为自定义消息内容,byte[]类型
建议定期清理本地历史记录。
原型:
public StatusCode DeleteHistoryMessage (ChatType chatType, ulong time)
参数:
chatType:指定是清理频道消息还是私聊消息time:Unix timestamp,精确到秒,表示删除这个时间点之前的所有历史记录
返回:
StatusCode:错误码,详细描述见错误码定义
可以根据ID删除对应的本地私聊历史记录。
原型:
public StatusCode DeleteHistoryMessageByID (ulong messageID)
参数:
messageID:将删除指定消息id的历史记录,对应 YIMEngine.HistoryMsg 的 MessageID 属性值。
返回:
StatusCode:错误码,详细描述见错误码定义
可以根据用户ID或者频道ID删除对应的本地聊天历史记录,保留消息ID白名单中的消息记录,白名单列表为空时删除与该用户ID或频道ID有关的所有本地聊天记录。
原型:
public StatusCode DeleteSpecifiedHistoryMessage (string targetID, ChatType chatType, ulong[] excludeMesList)
参数:
targetID:用户ID或者频道ID。chatType:聊天类型,私聊/频道聊天,1是私聊,2是频道聊天。excludeMesList:消息ID白名单,即保留的消息ID列表。
返回:
StatusCode:错误码,详细描述见错误码定义
可以根据用户ID或者频道ID删除以指定的起始消息ID开始的n条本地聊天历史记录,起始消息ID和消息数量使用默认值时则删除所有消息。
原型:
public StatusCode DeleteHistoryMessageByTarget (string targetID, ChatType chatType, ulong startMessageID, uint count)
参数:
targetID:用户ID或者频道IDchatType:聊天类型,私聊/频道聊天startMessageID:起始消息ID(默认值0表示最近的一条消息)count:消息数量(默认值0表示删除所有消息)
返回:
StatusCode:错误码,详细描述见错误码定义
该接口是根据本地历史消息记录生成的最近联系人列表,按最后聊天时间倒序排列。该列表会受清理历史记录消息的接口影响。
原型:
public void GetHistoryContact (Action<YouMe.StatusCode, List<ContactsSessionInfo>> callback)
参数:
Action<YouMe.StatusCode, List<ContactsSessionInfo>>:获取联系人列表的回调通知
备注:
Action<YouMe.StatusCode, List<ContactsSessionInfo>> 参数:StatusCode:code 错误码List<ContactsSessionInfo>:contactList 联系人信息列表
ContactsSessionInfo有如下属性:ContactID:联系人ID,string类型MessageType:消息类型,枚举类型,MessageBodyTypeMessageContent:消息内容,string类型CreateTime:消息时间,int类型
将文本翻译成指定语言的文本,异步返回结果
原型:
public void TranslateText( string text, LanguageCode destLangCode, LanguageCode srcLangCode,Action<StatusCode,string, LanguageCode, LanguageCode> callback)
参数:
text:文本destLangCode 目标语言,可查看LanguageCode枚举srcLangCode: 原语言,可查看LanguageCode枚举Action<StatusCode,string,LanguageCode,LanguageCode> 回调
备注:
Action<StatusCode,string,LanguageCode,LanguageCode> 参数:ErrorCode 错误码string text 目标语言文本LanguageCode srcLangCode 原语言,可查看LanguageCode枚举LanguageCode destLangCode 目标语言,枚举类型
考虑到客户端可能需要传递一些自定义消息,关键字过滤方法就直接提供出来,客户端可以选择是否过滤关键字,并且可以根据匹配到的等级进行过滤。比如level返回的值为'2'表示广告,那么可以在发送时选择不发送,接收放可以选择不展示。
原型:
public static string GetFilterText (string strSource, int level = 0)
参数:
strSource:消息原文level:可选参数,匹配的策略词等级,默认为0,0表示正常,其余值是按需求可配
返回值:
过滤关键字后的消息,敏感字会替换为"*"
建议游戏切入后台时通知该接口,以便于得到更好重连效果;
调用OnPause(false),在游戏切入后台后,若IM是登录状态,依旧接收IM消息;
调用OnPause(true),游戏切入后台,即使IM是登录状态也不会接收IM消息;在游戏恢复运行时会主动拉取暂停期间未接收的消息,收到OnRecvMessage()回调。
原型:
public void OnPause(bool pauseReceiveMessage)
参数:
pauseReceiveMessage:是否暂停接收IM消息,true-暂停接收 false-不暂停接收
建议游戏恢复运行时通知该接口,以便于得到更好重连效果。建议添加到全局MonoBehaviour的OnApplicationPause通知里。
public void OnResume()
Accusation接口提供举报功能,对用户违规的发言内容进行举报,管理员在后台进行审核处理并将结果通知用户,结果通过SetAccusationListener (Action<YouMe.StatusCode, IMAccusationInfo> listener)设置的监听返回。
原型
public StatusCode Accusation (string userID, ChatType chatType, int reason, string description, string extraParam)
参数:
userID:被举报用户IDchatType:来源(私聊/频道,1是私聊,2是频道聊天)reason:原因,由用户自定义枚举description:原因描述extraParam:附加信息JSON格式 ({"nickname":"","server_area":"","level":"","vip_level":""})
返回:
StatusCode:错误码,详细描述见错误码定义
举报处理结果通知
当管理员对举报进行审核处理后,会将举报处理结果通知用户
备注:
Action<YouMe.StatusCode, IMAccusationInfo> 参数:StatusCode:code 错误码IMAccusationInfo:accusationInfo 举报反馈信息
IMAccusationInfo有如下属性:UserID:被举报用户ID,string类型AccusationTime:举报时间,uint类型AccusationDealResult:处理结果,枚举类型,
IMAccusationDealResult.IGNORE=0, //忽略
IMAccusationDealResult.WARNING=1, //警告
IMAccusationDealResult.FROBIDDEN_SPEAK=2, //禁言
IMAccusationDealResult.UNKNOWN=3 //未知
用户查询所在频道的禁言状态。
原型:
public void GetForbiddenSpeakInfo (Action<YouMe.StatusCode, List<ForbiddenSpeakInfo> > callback)
参数:
Action<YouMe.StatusCode, List<ForbiddenSpeakInfo>>: 获取禁言状态的回调通知
备注:
Action<YouMe.StatusCode, List<ForbiddenSpeakInfo>> 参数:StatusCode:code 错误码List<ForbiddenSpeakInfo>:forbidInfoList 禁言状态列表,每一个代表一个禁言状态
ForbiddenSpeakInfo有如下属性:ChannelID:频道ID,string类型IsForbidRoom:是否为禁言频道,bool类型ReasonType:禁言原因,int类型,0-未知,1-发广告,2-侮辱,3-政治敏感,4-恐怖主义,5-反动,6-色情,7-其它EndTime:禁言结束时间,ulong类型
基本流程:申请开通公告功能->后台添加新公告然后设置公告发送时间,公告消息类型,发送时间,接收公告的频道等。->(客户端流程) 设置对应监听-> 调用对应接口->回调接收
1.公告发送由后台配置,如类型、周期、发送时间、内容、链接、目标频道、次数、起始结束时间等。
2.公告三种类型:跑马灯,聊天框,置顶公告,
(1) 跑马灯,聊天框公告可设置发送时间,次数和间隔(从指定时间点开始隔固定间隔时间发送多次,界面展示及显示时长由客户端决定);
(2) 置顶公告需设置开始和结束时间(该段时间内展示)。
3.三种公告均有一次性、周期性两种循环属性:
一次性公告,到达指定时间点,发送该条公告;
周期性公告,跟一次性公告发送规则一致,但是可以设置发送周期(在每周哪几天的指定时间发送)。
4.跑马灯与聊天框公告只有发送时间点在线的用户才能收到该公告,显示规则由客户端自己决定,两者区别主要是界面显示的区分。
5.置顶公告有显示起始和结束时间,表示该时段内显示,公告发送时间点在线的用户会收到该公告,公告发送时间点未在线用户,在公告显示时段登录,登录后可通过查询公告接口查到该公告。
6.公告撤销
仅针对置顶公告,公告显示时段撤销公告,客户端会收到公告撤销通知,界面进行更新。
管理员在后台发布公告,当到达指定时间会收到该公告,界面根据不同类型的公告进行展示。
设置接收公告的监听SetRecvNoticeListener (Action<YIMEngine.Notice> listener),可以接收到公告
示例:
void OnRecvNotice(YIMEngine.Notice notice){...}
备注:
Action<YIMEngine.Notice> 参数:Notice:notice 公告信息
Notice有如下属性:NoticeID:公告ID,ulong类型NoticeType:公告类型,int类型ChannelID:频道ID,string类型Content:公告内容,string类型LinkText:公告链接文本,string类型LinkAddr:公告链接地址,string类型BeginTime:公告开始时间,uint类型EndTime:公告结束时间,uint类型
对于某些类型的公告(如置顶公告),需要在界面展示一段时间,如果管理员在该时间段执行撤销该公告,会收到撤销公告通知,界面进行相应更新。
设置撤销公告的监听SetCancelNoticeListener (Action<ulong, string> listener),可以接收到撤销公告通知
示例:
void OnCancelNotice(ulong noticeID, string channelID){...}
备注:
Action<ulong, string> 参数:ulong:noticeID 公告IDstring:channelID 频道ID
公告在配置的时间点下发到客户端,对于某些类型的公告(如置顶公告)需要在某个时间段显示在,如果用户在公告下发时间点未在线,而在公告展示时间段内登录,应用可根据自己的需要决定是否展示该公告,QueryNotice查询公告,公告结果通过SetRecvNoticeListener (Action<YIMEngine.Notice> listener)设置的监听返回。
原型:
public StatusCode QueryNotice ()
返回:
StatusCode:错误码,详细描述见错误码定义
获取用户当前地理位置。
原型:
public StatusCode GetCurrentLocation ()
返回:
StatusCode:错误码,详细描述见错误码定义
回调:
当前的地理位置信息由SetGetCurrentLocationListener (Action<YouMe.StatusCode, GeographyLocation> listener)设置的监听接收。
备注:
Action<YouMe.StatusCode, GeographyLocation> 参数:StatusCode:code 错误码GeographyLocation:location 位置信息
GeographyLocation有如下属性:DistrictCode:地理区域编码,可根据此参数组合附近频道id,uint类型Country:国家,string类型Province:省份,string类型City:城市,string类型DistrictCounty:区县,string类型Street:街道,string类型Longitude:经度,double类型Latitude:纬度,double类型
从资源和耗电方面考虑,SDK不自动监听地理位置的变化,如果调用方有需要可调用YIMLocationManager的SetUpdateInterval接口,设置更新时间间隔,SDK会按设定的时间间隔监听位置变化并通知上层。(如果应用对地理位置变化关注度不大,最好不要设置自动更新)
原型:
public void SetUpdateInterval (uint interval)
参数:
interval:更新间隔时间 分钟
回调:
按照设定的时间间隔将当前的地理位置信息传给SetGetCurrentLocationListener (Action<YouMe.StatusCode, GeographyLocation> listener)设置的监听。
备注:
Action<YouMe.StatusCode, GeographyLocation> 参数:StatusCode:code 错误码GeographyLocation:location 位置信息
GeographyLocation有如下属性:DistrictCode:地理区域编码,可根据此参数组合附近频道id,uint类型Country:国,string类型Province:省,string类型City:城市,string类型DistrictCounty:区县,string类型Street:街,string类型Longitude:经度,double类型Latitude:纬度,double类型
获取附近的目标(人 频道) ,若需要此功能,请联系我们开启LBS服务。若已开启服务,此功能生效的前提是自己和附近的人都获取了自己的地理位置,即调用了IM的获取当前地理位置接口。
条件: 需要开通LBS定位服务才能使用
原型:
public void GetNearbyObjects (int count, string serverAreaID, Action<YouMe.StatusCode, IMNearbyObjectInfo> callback, DistrictLevel districtlevel = YIMEngine.DistrictLevel.DISTRICT_UNKNOW, bool resetStartDistance = false)
参数:
count: 获取附近的目标 获取数量(一次最大200)serverAreaID:区服(对应设置用户信息中的区服,如果只需要获得本服务器的,要填;否则填"")Action<YouMe.StatusCode, IMNearbyObjectInfo>:获取附近用户的回调通知districtlevel:可选参数,行政区划等级,默认值不划分等级resetStartDistance:可选参数,是否重置查找起始距离,默认是不重置,true-从距自己0米开始查找,false-从上次查找返回的最远用户开始查找
备注:
Action<YouMe.StatusCode, IMNearbyObjectInfo> 参数:StatusCode:code 错误码IMNearbyObjectInfo:nearbyObj 附近用户信息
IMNearbyObjectInfo有如下属性:StartDistance:搜索的起始距离,uint类型EndDistance:搜索的结束距离,uint类型NeighbourList:附近的人地理位置信息列表,List<RelativeLocation>类型
RelativeLocation有如下属性:Distance:与自己的距离,uint类型UserID:附近用户ID,string类型Country:国家,string类型Province:省份,string类型City:城市,string类型DistrictCounty:区县,string类型Street:街道,string类型(目前只精确到区县,街道为保留字段)Longitude:经度,double类型Latitude:纬度,double类型
<a id="服务器部署地区定义"></a>
ServerZone.China = 0 // 中国
ServerZone.Singapore = 1 // 新加坡
ServerZone.America = 2 // 美国
ServerZone.HongKong = 3 // 香港
ServerZone.Korea = 4 // 韩国
ServerZone.Australia = 5 // 澳洲
ServerZone.Deutschland = 6 // 德国
ServerZone.Brazil = 7 // 巴西
ServerZone.India = 8 // 印度
ServerZone.Japan = 9 // 日本
ServerZone.Ireland = 10 // 爱尔兰
ServerZone.ServerZone_Unknow = 9999
<a id="错误码定义"></a>
| 错误码 | 含义 |
|---|---|
| StatusCode.Success = 0 | 成功 |
| StatusCode.EngineNotInit = 1 | IM SDK未初始化 |
| StatusCode.NotLogin = 2 | IM SDK未登录 |
| StatusCode.ParamInvalid = 3 | 无效的参数 |
| StatusCode.TimeOut = 4 | 超时 |
| StatusCode.StatusError = 5 | 状态错误 |
| StatusCode.SDKInvalid = 6 | Appkey无效 |
| StatusCode.AlreadyLogin = 7 | 已经登录 |
| StatusCode.LoginInvalid = 1001 | 登录无效 |
| StatusCode.ServerError = 8 | 服务器错误 |
| StatusCode.NetError = 9 | 网络错误 |
| StatusCode.LoginSessionError = 10 | 登录状态出错 |
| StatusCode.NotStartUp = 11 | SDK未启动 |
| StatusCode.FileNotExist = 12 | 文件不存在 |
| StatusCode.SendFileError = 13 | 文件发送出错 |
| StatusCode.UploadFailed = 14 | 文件上传失败 |
| StatusCode.UsernamePasswordError = 15 | 用户名密码和最后一次登录成功的不匹配 |
| StatusCode.UserStatusError = 16 | 状态错误,一般是非登录状态调用了需要登录后才能操作的接口 |
| StatusCode.MessageTooLong = 17 | 消息太长,主控制在2k以内 |
| StatusCode.ReceiverTooLong = 18 | 接收方ID过长(检查频道名) |
| StatusCode.InvalidChatType = 19 | 无效聊天类型(私聊、聊天室) |
| StatusCode.InvalidReceiver = 20 | 无效用户ID(私聊接受者为数字格式ID) |
| StatusCode.UnknowError = 21 | 请求错误,常见的情况是指定的接收者不存在 |
| StatusCode.InvalidAppkey = 22 | APPKEY校验不通过 |
| StatusCode.ForbiddenSpeak = 23 | 被禁言 |
| StatusCode.CreateFileFailed = 24 | 创建文件失败 |
| StatusCode.UnsupportFormat = 25 | 不支持的文件格式 |
| StatusCode.ReceiverEmpty = 26 | 接收方为空 |
| StatusCode.RoomIDTooLong = 27 | 频道名太长,不要超过128字节 |
| StatusCode.ContentInvalid = 28, | 聊天内容严重非法 |
| StatusCode.NoLocationAuthrize = 29, | 未打开定位权限 |
| StatusCode.UnknowLocation = 30, | 未知位置 |
| StatusCode.Unsupport = 31, | 不支持该接口 |
| StatusCode.NoAudioDevice = 32, | 无音频设备 |
| StatusCode.AudioDriver = 33, | 音频驱动问题 |
| StatusCode.DeviceStatusInvalid = 34, | 设备状态错误 |
| StatusCode.ResolveFileError = 35, | 文件解析错误 |
| StatusCode.ReadWriteFileError = 36, | 文件读写错误 |
| StatusCode.NoLangCode = 37, | 语言编码错误 |
| StatusCode.TranslateUnable = 38, | 翻译接口不可用 |
| StatusCode.SpeechAccentInvalid = 39, | 语音识别方言无效 |
| StatusCode.SpeechLanguageInvalid = 40, | 语音识别语言无效 |
| StatusCode.HasIllegalText = 41, | 消息含非法字符 |
| StatusCode.AdvertisementMessage = 42, | 消息涉嫌广告 |
| StatusCode.AlreadyBlock = 43, | 用户已经被屏蔽 |
| StatusCode.NotBlock = 44, | 用户未被屏蔽 |
| StatusCode.MessageBlocked = 45, | 消息被屏蔽 |
| StatusCode.LocationTimeout = 46, | 定位超时 |
| StatusCode.NotJoinRoom = 47, | 未加入该频道 |
| StatusCode.LoginTokenInvalid = 48, | 登录token错误 |
| StatusCode.CreateDirectoryFailed = 49, | 创建目录失败 |
| StatusCode.InitFailed = 50, | 初始化失败 |
| StatusCode.Disconnect = 51, | 与服务器断开 |
| StatusCode_ALREADYFRIENDS = 1000, | 服务器错误 |
| StatusCode_LoginInvalid = 1001, | 服务器错误登录无效 |
| StatusCode.PTT_Start = 2000 | 开始录音 |
| StatusCode.PTT_Fail = 2001 | 录音失败 |
| StatusCode.PTT_DownloadFail = 2002 | 语音消息文件下载失败 |
| StatusCode.PTT_GetUploadTokenFail = 2003 | 获取语音消息Token失败 |
| StatusCode.PTT_UploadFail = 2004 | 语音消息文件上传失败 |
| StatusCode.PTT_NotSpeech = 2005 | 没有录音内容 |
| StatusCode.PTT_DeviceStatusError = 2006 | 音频设备状态错误 |
| StatusCode.PTT_IsSpeeching = 2007 | 已经在录音中 |
| StatusCode.PTT_FileNotExist = 2008 | 找不到录音生成的文件 |
| StatusCode.PTT_ReachMaxDuration = 2009 | 达到语音最大时长限制 |
| StatusCode.PTT_SpeechTooShort = 2010 | 语音时长太短 |
| StatusCode.PTT_StartAudioRecordFailed = 2011 | 启动语音失败 |
| StatusCode.PTT_SpeechTimeout = 2012 | 音频输入超时 |
| StatusCode.PTT_IsPlaying = 2013 | 正在播放 |
| StatusCode.PTT_NotStartPlay = 2014 | 未开始播放 |
| StatusCode.PTT_CancelPlay = 2015 | 主动取消播放 |
| StatusCode.PTT_NotStartRecord = 2016, | 未开始语音 |
| StatusCode.PTT_NotInit = 2017, | 未初始化 |
| StatusCode.PTT_InitFailed = 2018, | 初始化失败 |
| StatusCode.PTT_Authorize = 2019, | 录音权限 |
| StatusCode.PTT_StartRecordFailed = 2020, | 启动录音失败 |
| StatusCode.PTT_StopRecordFailed = 2021, | 停止录音失败 |
| StatusCode.PTT_UnsupprtFormat = 2022, | 不支持的格式 |
| StatusCode.PTT_ResolveFileError = 2023, | 解析文件错误 |
| StatusCode.PTT_ReadWriteFileError = 2024, | 读写文件错误 |
| StatusCode.PTT_ConvertFileFailed = 2025, | 文件转换失败 |
| StatusCode.PTT_NoAudioDevice = 2026, | 无音频设备 |
| StatusCode.PTT_NoDriver = 2027, | 驱动问题 |
| StatusCode.PTT_StartPlayFailed = 2028, | 启动播放失败 |
| StatusCode.PTT_StopPlayFailed = 2029, | 停止播放失败 |
| StatusCode.Fail = 10000 | 语音服务启动失败 |
| StatusCode.START_DOWNLOAD_FAIL = 20001 | 开始下载失败 |
| StatusCode.IS_WAITING_DOWNLOAD = 20002 | 下载队列中待下载 |
| StatusCode.IS_WAITING_UPLOAD = 20003 | 上传队列中待上传 |
| StatusCode.IS_WAITING_SEND = 20004 | 消息队列中待发送 |
| StatusCode.QUERY_RECORDS_FAIL = 20005 | 查询历史记录失败 |
| StatusCode.GET_CONTACTS_FAIL = 20006 | 获取联系人列表失败 |
| StatusCode.GET_USER_INFO_FAIL = 20007 | 获取用户信息失败 |
| StatusCode.QUERY_USER_STATUS_FAIL = 20008 | 查询用户状态失败 |
| StatusCode.START_PLAY_FAIL = 20009 | 开始播放语音失败 |
| StatusCode.STOPPLAY_FAIL_BEFORE_START = 20010 | 调用开始播放前停止播放失败 |
| StatusCode.GET_CURRENT_LOCATION_FAIL = 20011 | 获取当前地理位置失败 |
| StatusCode.GET_NERABY_OBJECTS_FAIL = 20012 | 获取附近人失败 |
| StatusCode.GET_MICROPHONE_STATUS_FAIL = 20013 | 获取麦克风状态失败 |
| StatusCode.REPORT_FAIL = 20014 | 举报失败 |
| StatusCode.GET_FORBIDDEN_SPEAKINFO_FAIL = 20015 | 获取禁言状态失败 |
| StatusCode.BLOCK_USER_FAIL = 20016 | 屏蔽用户失败 |
| StatusCode.UNBLOCK_ALL_USER_FAIL = 20017 | 解除所有的用户屏蔽失败 |
| StatusCode.GET_BLOCK_USERS_FAIL = 20018 | 获取屏蔽用户失败 |
| StatusCode.HAS_NO_MICROPHONE_AUTHORITY = 20019 | 没有麦克风权限 |